Standard Operating Procedure - MkDocs
Most recently edited by: Paul VanderWeele
Most recent edit date: Feb 22, 2022
Edits were authorized by: Paul VanderWeele
Table of Contents
Related Procedures
Purpose and Scope
Terms and Definitions
Training and Authorization
Additional Information
Related Procedures
QSP - Document Control and Management
Markdown
Github
Ubuntu
BASH
Workstations
Python
Purpose and Scope
The purpose of this procedure is to explain how to ultilize the Command Line Utility known as "MkDocs" for documentation. It is a Python-based application that compiles Markdown and TeX syntax to generate simple and efficiently formatted web-based documents. It also has the capability of publishing documents directly to Github Pages
Terms and Definitions
Command Line Utility
A Command Line Utility is a tool that you can run on the command line of a computer.
Training and Authorization
Training is done by completing the MkDocs Getting Started Guide. Evidence of competency is shown by successfully deploying a MkDocs document to Github.com. The supervisor is the Owner of the NEW AGE Github Organization if the evidence is submitted to Github, and evidence of Authorization is done by either forking the repository of evidence, or making a subsequent commit to the same repository.